| Package | hl7.cda.us.ccda |
| Resource Type | StructureDefinition |
| Id | SubstanceOrDeviceAllergyIntoleranceObservation |
| FHIR Version | R5 |
| Source | http://hl7.org/cda/us/ccda/https://build.fhir.org/ig/HL7/CDA-ccda/StructureDefinition-SubstanceOrDeviceAllergyIntoleranceObservation.html |
| URL | http://hl7.org/cda/us/ccda/StructureDefinition/SubstanceOrDeviceAllergyIntoleranceObservation |
| Version | 4.0.0 |
| Status | draft |
| Date | 2025-06-26T21:09:45+00:00 |
| Name | SubstanceOrDeviceAllergyIntoleranceObservation |
| Title | Substance or Device Allergy - Intolerance Observation |
| Realm | us |
| Authority | hl7 |
| Description | This template reflects a discrete observation about a patient's allergy or intolerance to a substance or device. Because it is a discrete observation, it will have a statusCode of "completed". The effectiveTime, also referred to as the 'clinically relevant time' is the time at which the observation holds for the patient. For a provider seeing a patient in the clinic today, observing a history of penicillin allergy that developed five years ago, the effectiveTime is five years ago. The effectiveTime of the Substance or Device Allergy - Intolerance Observation is the definitive indication of whether or not the underlying allergy/intolerance is resolved. If known to be resolved, then an effectiveTime/high would be present. If the date of resolution is not known, then effectiveTime/high will be present with a nullFlavor of "UNK". #### Templates Used Although open templates may contain any valid CDA content, the following templates are specifically called out by this template: **Optional EntryRelationships**: [AllergyStatusObservation](StructureDefinition-AllergyStatusObservation.html), [CriticalityObservation](StructureDefinition-CriticalityObservation.html), [ReactionObservation](StructureDefinition-ReactionObservation.html), [SeverityObservation](StructureDefinition-SeverityObservation.html) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation |
| Kind | logical |
| StructureDefinition | |
| AllergyIntoleranceObservation | Allergy - Intolerance Observation |
| HealthConcernAct | Health Concern Act |
| RiskConcernAct | Risk Concern Act |
| StructureDefinition | |
| Author | Author (CDA Class) |
| CD | CD: ConceptDescriptor (V3 Data Type) |
| Observation | Observation (CDA Class) |
| AllergyStatusObservation | Allergy Status Observation |
| AuthorParticipation | Author Participation |
| CriticalityObservation | Criticality Observation |
| ReactionObservation | Reaction Observation |
| SeverityObservation | Severity Observation |
| ValueSet | |
| 2.16.840.1.113762.1.4.1010.1 | Substance Reactant for Intolerance |
| 2.16.840.1.113883.3.88.12.3221.6.2 | Allergy and Intolerance Type |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition SubstanceOrDeviceAllergyIntoleranceObservation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | C | 1..1 | Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, sdtcCategory, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-author, should-not-severity |
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:substance-device-allergy-intolerance-obs | 1..1 | II | ||
  @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.24.3.90 | |
  @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode | 1..1 | cs | Fixed Value: OBS | |
| @moodCode | 1..1 | cs | Fixed Value: EVN | |
| id | 1..* | II | ||
| code | 1..1 | CD | ||
| @code | 1..1 | cs | Required Pattern: ASSERTION | |
 @codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.5.4 | |
| text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference | C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| statusCode | 1..1 | CS | ||
| @code | 1..1 | cs | Fixed Value: completed | |
| effectiveTime | 1..1 | IVL_TS | The effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became clinically active. The effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became clinically resolved. If the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'. | |
| low | 1..1 | IVXB_TS | ||
| high | 0..1 | IVXB_TS | ||
 value | 1..1 | CD | ||
| @nullFlavor | 0..0 | |||
| @code | 1..1 | cs | Binding: Allergy and Intolerance Type  (required) | |
| author | 0..* | AuthorParticipation | ||
| Slices for participant | 0..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:consumable | 0..* | Participant2 | participant | |
| @typeCode | 1..1 | cs | Fixed Value: CSM | |
| participantRole | 1..1 | ParticipantRole | ||
| @classCode | 1..1 | cs | Fixed Value: MANU | |
| playingEntity | 1..1 | PlayingEntity | ||
| @classCode | 1..1 | cs | Fixed Value: MMAT | |
| code | 1..1 | CE | Binding: Substance Reactant for Intolerance (preferred) | |
| Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by profile:observation | |
 entryRelationship:status | 0..1 | EntryRelationship | entryRelationship | |
 @typeCode | 1..1 | cs | Fixed Value: SUBJ | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| observation | 1..1 | AllergyStatusObservation | ||
| entryRelationship:reaction | 0..* | EntryRelationship | entryRelationship | |
| @typeCode | 1..1 | cs | Fixed Value: MFST | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| observation | 1..1 | ReactionObservation | ||
| entryRelationship:severity | 0..1 | EntryRelationship | entryRelationship | |
| @typeCode | 1..1 | cs | Fixed Value: SUBJ | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| observation | 1..1 | SeverityObservation | ||
| entryRelationship:criticality | 0..1 | EntryRelationship | entryRelationship | |
| @typeCode | 1..1 | cs | Fixed Value: SUBJ | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| observation | 1..1 | CriticalityObservation | ||
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "SubstanceOrDeviceAllergyIntoleranceObservation",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"_valueBoolean": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "not-applicable"
}
]
}
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:v3"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "observation"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
"valueCode": "cda"
}
],
"url": "http://hl7.org/cda/us/ccda/StructureDefinition/SubstanceOrDeviceAllergyIntoleranceObservation",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:hl7ii:2.16.840.1.113883.10.20.24.3.90:2014-06-09"
}
],
"version": "4.0.0",
"name": "SubstanceOrDeviceAllergyIntoleranceObservation",
"title": "Substance or Device Allergy - Intolerance Observation",
"status": "draft",
"date": "2025-06-26T21:09:45+00:00",
"publisher": "Health Level Seven",
"contact": [
{
"name": "HL7 International - Structured Documents",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/structure"
}
]
}
],
"description": "This template reflects a discrete observation about a patient's allergy or intolerance to a substance or device. Because it is a discrete observation, it will have a statusCode of \"completed\". The effectiveTime, also referred to as the 'clinically relevant time' is the time at which the observation holds for the patient. For a provider seeing a patient in the clinic today, observing a history of penicillin allergy that developed five years ago, the effectiveTime is five years ago. \n\nThe effectiveTime of the Substance or Device Allergy - Intolerance Observation is the definitive indication of whether or not the underlying allergy/intolerance is resolved. If known to be resolved, then an effectiveTime/high would be present. If the date of resolution is not known, then effectiveTime/high will be present with a nullFlavor of \"UNK\".\n\n#### Templates Used\nAlthough open templates may contain any valid CDA content, the following templates are specifically called out by this template:\n\n**Optional EntryRelationships**: [AllergyStatusObservation](StructureDefinition-AllergyStatusObservation.html), [CriticalityObservation](StructureDefinition-CriticalityObservation.html), [ReactionObservation](StructureDefinition-ReactionObservation.html), [SeverityObservation](StructureDefinition-SeverityObservation.html)",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
],
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/cda/stds/core/StructureDefinition/Observation",
"baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/Observation",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "2.0.1-sd"
}
],
"element": [
{
"id": "Observation",
"path": "Observation",
"short": "Base for all types and resources",
"definition": "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.",
"min": 1,
"max": "1",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "should-text-ref-value",
"severity": "warning",
"human": "SHOULD contain text/reference/@value",
"expression": "text.reference.value.exists()",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/SubstanceOrDeviceAllergyIntoleranceObservation"
},
{
"key": "should-author",
"severity": "warning",
"human": "SHOULD contain author",
"expression": "author.exists()",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/SubstanceOrDeviceAllergyIntoleranceObservation"
},
{
"key": "should-not-severity",
"severity": "warning",
"human": "Allergy SHOULD NOT include severity. Severity belongs at reaction level, while Criticality is used at the allergy level.",
"expression": "entryRelationship.observation.where(code.code = 'SEV' and code.codeSystem = '2.16.840.1.113883.5.4').empty()",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/SubstanceOrDeviceAllergyIntoleranceObservation"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Observation.nullFlavor",
"path": "Observation.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.realmCode",
"path": "Observation.realmCode",
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.realmCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "Observation.typeId",
"path": "Observation.typeId",
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min": 0,
"max": "1",
"base": {
"path": "InfrastructureRoot.typeId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint": [
{
"key": "II-1",
"severity": "error",
"human": "An II instance must have either a root or an nullFlavor.",
"expression": "root.exists() or nullFlavor.exists()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id": "Observation.typeId.nullFlavor",
"path": "Observation.typeId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.typeId.assigningAuthorityName",
"path": "Observation.typeId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.typeId.displayable",
"path": "Observation.typeId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "Observation.typeId.root",
"path": "Observation.typeId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "Identifies the type as an HL7 Registered model",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString": "2.16.840.1.113883.1.3"
},
{
"id": "Observation.typeId.extension",
"path": "Observation.typeId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.templateId",
"path": "Observation.templateId",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "root"
},
{
"type": "value",
"path": "extension"
}
],
"rules": "open"
},
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min": 1,
"max": "*",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "Observation.templateId:substance-device-allergy-intolerance-obs",
"path": "Observation.templateId",
"sliceName": "substance-device-allergy-intolerance-obs",
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min": 1,
"max": "1",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "Observation.templateId:substance-device-allergy-intolerance-obs.nullFlavor",
"path": "Observation.templateId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.templateId:substance-device-allergy-intolerance-obs.assigningAuthorityName",
"path": "Observation.templateId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.templateId:substance-device-allergy-intolerance-obs.displayable",
"path": "Observation.templateId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "Observation.templateId:substance-device-allergy-intolerance-obs.root",
"path": "Observation.templateId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"patternString": "2.16.840.1.113883.10.20.24.3.90"
},
{
"id": "Observation.templateId:substance-device-allergy-intolerance-obs.extension",
"path": "Observation.templateId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
],
"patternString": "2014-06-09"
},
{
"id": "Observation.classCode",
"path": "Observation.classCode",
"representation": [
"xmlAttr"
],
"comment": "SHALL contain exactly one [1..1] @classCode=\"OBS\" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-16303).",
"min": 1,
"max": "1",
"base": {
"path": "Observation.classCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "OBS",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation"
}
},
{
"id": "Observation.moodCode",
"path": "Observation.moodCode",
"representation": [
"xmlAttr"
],
"comment": "SHALL contain exactly one [1..1] @moodCode=\"EVN\" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-16304).",
"min": 1,
"max": "1",
"base": {
"path": "Observation.moodCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "EVN",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0"
}
},
{
"id": "Observation.negationInd",
"path": "Observation.negationInd",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "Observation.negationInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "Observation.id",
"path": "Observation.id",
"comment": "SHALL contain at least one [1..*] id (CONF:1098-16307).",
"min": 1,
"max": "*",
"base": {
"path": "Observation.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "Observation.sdtcCategory",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "category"
}
],
"path": "Observation.sdtcCategory",
"min": 0,
"max": "*",
"base": {
"path": "Observation.sdtcCategory",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id": "Observation.code",
"path": "Observation.code",
"representation": [
"typeAttr"
],
"comment": "SHALL contain exactly one [1..1] code (CONF:1098-16345).",
"min": 1,
"max": "1",
"base": {
"path": "Observation.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ObservationType"
}
},
{
"id": "Observation.code.nullFlavor",
"path": "Observation.code.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.code.code",
"path": "Observation.code.code",
"representation": [
"xmlAttr"
],
"label": "Code",
"definition": "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"comment": "This code SHALL contain exactly one [1..1] @code=\"ASSERTION\" Assertion (CONF:1098-16346).",
"min": 1,
"max": "1",
"base": {
"path": "CD.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"patternCode": "ASSERTION"
},
{
"id": "Observation.code.codeSystem",
"path": "Observation.code.codeSystem",
"representation": [
"xmlAttr"
],
"label": "Code System",
"definition": "Specifies the code system that defines the code.",
"comment": "This code SHALL contain exactly one [1..1] @codeSystem=\"2.16.840.1.113883.5.4\" (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:1098-32171).",
"min": 1,
"max": "1",
"base": {
"path": "CD.codeSystem",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"patternString": "2.16.840.1.113883.5.4"
},
{
"id": "Observation.code.codeSystemName",
"path": "Observation.code.codeSystemName",
"representation": [
"xmlAttr"
],
"label": "Code System Name",
"definition": "The common name of the coding system.",
"min": 0,
"max": "1",
"base": {
"path": "CD.codeSystemName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.code.codeSystemVersion",
"path": "Observation.code.codeSystemVersion",
"representation": [
"xmlAttr"
],
"label": "Code System Version",
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"min": 0,
"max": "1",
"base": {
"path": "CD.codeSystemVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.code.displayName",
"path": "Observation.code.displayName",
"representation": [
"xmlAttr"
],
"label": "Display Name",
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"min": 0,
"max": "1",
"base": {
"path": "CD.displayName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.code.sdtcValueSet",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSet"
}
],
"path": "Observation.code.sdtcValueSet",
"representation": [
"xmlAttr"
],
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"min": 0,
"max": "1",
"base": {
"path": "CD.valueSet",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid"
]
}
]
},
{
"id": "Observation.code.sdtcValueSetVersion",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSetVersion"
}
],
"path": "Observation.code.sdtcValueSetVersion",
"representation": [
"xmlAttr"
],
"definition": "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"min": 0,
"max": "1",
"base": {
"path": "CD.sdtcValueSetVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.code.originalText",
"path": "Observation.code.originalText",
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding.",
"min": 0,
"max": "1",
"base": {
"path": "CD.originalText",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id": "Observation.code.qualifier",
"path": "Observation.code.qualifier",
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code.",
"min": 0,
"max": "*",
"base": {
"path": "CD.qualifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
}
]
},
{
"id": "Observation.code.translation",
"path": "Observation.code.translation",
"representation": [
"typeAttr"
],
"label": "Translation",
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min": 0,
"max": "*",
"base": {
"path": "CD.translation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id": "Observation.derivationExpr",
"path": "Observation.derivationExpr",
"min": 0,
"max": "1",
"base": {
"path": "Observation.derivationExpr",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ST"
}
]
},
{
"id": "Observation.text",
"path": "Observation.text",
"representation": [
"typeAttr"
],
"short": "SHOULD reference the portion of section narrative text corresponding to this entry",
"min": 0,
"max": "1",
"base": {
"path": "Observation.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id": "Observation.text.nullFlavor",
"path": "Observation.text.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.text.compression",
"path": "Observation.text.compression",
"representation": [
"xmlAttr"
],
"label": "Compression",
"definition": "Indicates whether the raw byte data is compressed, and what compression algorithm was used.",
"min": 0,
"max": "1",
"base": {
"path": "ED.compression",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm"
}
},
{
"id": "Observation.text.integrityCheck",
"path": "Observation.text.integrityCheck",
"representation": [
"xmlAttr"
],
"label": "Integrity Check",
"definition": "The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.",
"min": 0,
"max": "1",
"base": {
"path": "ED.integrityCheck",
"min": 0,
"max": "1"
},
"type": [
{
"code": "base64Binary",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bin"
]
}
]
},
{
"id": "Observation.text.integrityCheckAlgorithm",
"path": "Observation.text.integrityCheckAlgorithm",
"representation": [
"xmlAttr"
],
"label": "Integrity Check Algorithm",
"definition": "Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.",
"min": 0,
"max": "1",
"base": {
"path": "ED.integrityCheckAlgorithm",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0"
}
},
{
"id": "Observation.text.language",
"path": "Observation.text.language",
"representation": [
"xmlAttr"
],
"label": "Language",
"definition": "For character based information the language property specifies the human language of the text.",
"min": 0,
"max": "1",
"base": {
"path": "ED.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id": "Observation.text.mediaType",
"path": "Observation.text.mediaType",
"representation": [
"xmlAttr"
],
"label": "Media Type",
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min": 0,
"max": "1",
"base": {
"path": "ED.mediaType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-MediaType"
}
},
{
"id": "Observation.text.representation",
"path": "Observation.text.representation",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "ED.representation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding"
}
},
{
"id": "Observation.text.xmlText",
"path": "Observation.text.xmlText",
"representation": [
"xmlText"
],
"short": "Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.",
"definition": "Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min": 0,
"max": "1",
"base": {
"path": "ED.xmlText",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.text.reference",
"path": "Observation.text.reference",
"label": "Reference",
"definition": "A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.",
"min": 0,
"max": "1",
"base": {
"path": "ED.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
],
"constraint": [
{
"key": "value-starts-octothorpe",
"severity": "error",
"human": "If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative",
"expression": "value.exists() implies value.startsWith('#')",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/SubstanceOrDeviceAllergyIntoleranceObservation"
}
]
},
{
"id": "Observation.text.thumbnail",
"path": "Observation.text.thumbnail",
"label": "Thumbnail",
"definition": "An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.",
"min": 0,
"max": "1",
"base": {
"path": "ED.thumbnail",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id": "Observation.statusCode",
"path": "Observation.statusCode",
"comment": "SHALL contain exactly one [1..1] statusCode (CONF:1098-16308).",
"min": 1,
"max": "1",
"base": {
"path": "Observation.statusCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActStatus"
}
},
{
"id": "Observation.statusCode.nullFlavor",
"path": "Observation.statusCode.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.statusCode.code",
"path": "Observation.statusCode.code",
"representation": [
"xmlAttr"
],
"label": "Code",
"definition": "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"comment": "This statusCode SHALL contain exactly one [1..1] @code=\"completed\" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-26354).",
"min": 1,
"max": "1",
"base": {
"path": "CD.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "completed"
},
{
"id": "Observation.statusCode.codeSystem",
"path": "Observation.statusCode.codeSystem",
"representation": [
"xmlAttr"
],
"label": "Code System",
"definition": "Specifies the code system that defines the code.",
"min": 0,
"max": "0",
"base": {
"path": "CD.codeSystem",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
]
},
{
"id": "Observation.statusCode.codeSystemName",
"path": "Observation.statusCode.codeSystemName",
"representation": [
"xmlAttr"
],
"label": "Code System Name",
"definition": "The common name of the coding system.",
"min": 0,
"max": "0",
"base": {
"path": "CD.codeSystemName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.statusCode.codeSystemVersion",
"path": "Observation.statusCode.codeSystemVersion",
"representation": [
"xmlAttr"
],
"label": "Code System Version",
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"min": 0,
"max": "0",
"base": {
"path": "CD.codeSystemVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.statusCode.displayName",
"path": "Observation.statusCode.displayName",
"representation": [
"xmlAttr"
],
"label": "Display Name",
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"min": 0,
"max": "0",
"base": {
"path": "CD.displayName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.statusCode.sdtcValueSet",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSet"
}
],
"path": "Observation.statusCode.sdtcValueSet",
"representation": [
"xmlAttr"
],
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"min": 0,
"max": "1",
"base": {
"path": "CD.valueSet",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid"
]
}
]
},
{
"id": "Observation.statusCode.sdtcValueSetVersion",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSetVersion"
}
],
"path": "Observation.statusCode.sdtcValueSetVersion",
"representation": [
"xmlAttr"
],
"definition": "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"min": 0,
"max": "1",
"base": {
"path": "CD.sdtcValueSetVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.statusCode.originalText",
"path": "Observation.statusCode.originalText",
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding.",
"min": 0,
"max": "0",
"base": {
"path": "CD.originalText",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id": "Observation.statusCode.qualifier",
"path": "Observation.statusCode.qualifier",
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code.",
"min": 0,
"max": "0",
"base": {
"path": "CD.qualifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
}
]
},
{
"id": "Observation.statusCode.translation",
"path": "Observation.statusCode.translation",
"representation": [
"typeAttr"
],
"label": "Translation",
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min": 0,
"max": "0",
"base": {
"path": "CD.translation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id": "Observation.effectiveTime",
"path": "Observation.effectiveTime",
"short": "The effectiveTime/low (a.k.a. \"onset date\") asserts when the allergy/intolerance became clinically active. The effectiveTime/high (a.k.a. \"resolution date\") asserts when the allergy/intolerance became clinically resolved. If the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'.",
"comment": "SHALL contain exactly one [1..1] effectiveTime (CONF:1098-16309).",
"min": 1,
"max": "1",
"base": {
"path": "Observation.effectiveTime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
}
]
},
{
"id": "Observation.effectiveTime.nullFlavor",
"path": "Observation.effectiveTime.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.effectiveTime.value",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-format",
"valueString": "YYYYMMDDHHMMSS.UUUU[+|-ZZzz]"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-date-rules",
"valueString": "year-valid"
}
],
"path": "Observation.effectiveTime.value",
"representation": [
"xmlAttr"
],
"definition": "A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.",
"min": 0,
"max": "1",
"base": {
"path": "TS.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/ts-simple"
]
}
]
},
{
"id": "Observation.effectiveTime.operator",
"path": "Observation.effectiveTime.operator",
"representation": [
"xmlAttr"
],
"definition": "A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.",
"min": 0,
"max": "1",
"base": {
"path": "SXCM_TS.operator",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode": "I",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDASetOperator"
}
},
{
"id": "Observation.effectiveTime.low",
"path": "Observation.effectiveTime.low",
"label": "Low Boundary",
"definition": "This is the low limit of the interval.",
"comment": "This effectiveTime SHALL contain exactly one [1..1] low (CONF:1098-31536).",
"min": 1,
"max": "1",
"base": {
"path": "IVL_TS.low",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS"
}
]
},
{
"id": "Observation.effectiveTime.center",
"path": "Observation.effectiveTime.center",
"label": "Central Value",
"definition": "The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.",
"min": 0,
"max": "1",
"base": {
"path": "IVL_TS.center",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
}
]
},
{
"id": "Observation.effectiveTime.width",
"path": "Observation.effectiveTime.width",
"label": "Width",
"definition": "The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.",
"min": 0,
"max": "1",
"base": {
"path": "IVL_TS.width",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PQ"
}
]
},
{
"id": "Observation.effectiveTime.high",
"path": "Observation.effectiveTime.high",
"label": "High Boundary",
"definition": "This is the high limit of the interval.",
"comment": "This effectiveTime MAY contain zero or one [0..1] high (CONF:1098-31537).",
"min": 0,
"max": "1",
"base": {
"path": "IVL_TS.high",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS"
}
]
},
{
"id": "Observation.priorityCode",
"path": "Observation.priorityCode",
"min": 0,
"max": "1",
"base": {
"path": "Observation.priorityCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActPriority"
}
},
{
"id": "Observation.repeatNumber",
"path": "Observation.repeatNumber",
"min": 0,
"max": "1",
"base": {
"path": "Observation.repeatNumber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT"
}
]
},
{
"id": "Observation.languageCode",
"path": "Observation.languageCode",
"min": 0,
"max": "1",
"base": {
"path": "Observation.languageCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"id": "Observation.value",
"path": "Observation.value",
"representation": [
"typeAttr"
],
"comment": "SHALL contain exactly one [1..1] value with @xsi:type=\"CD\" (CONF:1098-16312).",
"min": 1,
"max": "1",
"base": {
"path": "Observation.value",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id": "Observation.value.nullFlavor",
"path": "Observation.value.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "0",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.value.code",
"path": "Observation.value.code",
"representation": [
"xmlAttr"
],
"label": "Code",
"definition": "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"min": 1,
"max": "1",
"base": {
"path": "CD.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.6.2"
}
},
{
"id": "Observation.value.codeSystem",
"path": "Observation.value.codeSystem",
"representation": [
"xmlAttr"
],
"label": "Code System",
"definition": "Specifies the code system that defines the code.",
"min": 0,
"max": "1",
"base": {
"path": "CD.codeSystem",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
]
},
{
"id": "Observation.value.codeSystemName",
"path": "Observation.value.codeSystemName",
"representation": [
"xmlAttr"
],
"label": "Code System Name",
"definition": "The common name of the coding system.",
"min": 0,
"max": "1",
"base": {
"path": "CD.codeSystemName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.value.codeSystemVersion",
"path": "Observation.value.codeSystemVersion",
"representation": [
"xmlAttr"
],
"label": "Code System Version",
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"min": 0,
"max": "1",
"base": {
"path": "CD.codeSystemVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.value.displayName",
"path": "Observation.value.displayName",
"representation": [
"xmlAttr"
],
"label": "Display Name",
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"min": 0,
"max": "1",
"base": {
"path": "CD.displayName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.value.sdtcValueSet",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSet"
}
],
"path": "Observation.value.sdtcValueSet",
"representation": [
"xmlAttr"
],
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"min": 0,
"max": "1",
"base": {
"path": "CD.valueSet",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid"
]
}
]
},
{
"id": "Observation.value.sdtcValueSetVersion",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSetVersion"
}
],
"path": "Observation.value.sdtcValueSetVersion",
"representation": [
"xmlAttr"
],
"definition": "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"min": 0,
"max": "1",
"base": {
"path": "CD.sdtcValueSetVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.value.originalText",
"path": "Observation.value.originalText",
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding.",
"min": 0,
"max": "1",
"base": {
"path": "CD.originalText",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id": "Observation.value.qualifier",
"path": "Observation.value.qualifier",
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code.",
"min": 0,
"max": "*",
"base": {
"path": "CD.qualifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
}
]
},
{
"id": "Observation.value.translation",
"path": "Observation.value.translation",
"representation": [
"typeAttr"
],
"label": "Translation",
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min": 0,
"max": "*",
"base": {
"path": "CD.translation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id": "Observation.interpretationCode",
"path": "Observation.interpretationCode",
"min": 0,
"max": "*",
"base": {
"path": "Observation.interpretationCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation"
}
},
{
"id": "Observation.methodCode",
"path": "Observation.methodCode",
"min": 0,
"max": "*",
"base": {
"path": "Observation.methodCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ObservationMethod"
}
},
{
"id": "Observation.targetSiteCode",
"path": "Observation.targetSiteCode",
"definition": "Drawn from concept domain ActSite",
"min": 0,
"max": "*",
"base": {
"path": "Observation.targetSiteCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id": "Observation.subject",
"path": "Observation.subject",
"min": 0,
"max": "1",
"base": {
"path": "Observation.subject",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Subject"
}
]
},
{
"id": "Observation.specimen",
"path": "Observation.specimen",
"min": 0,
"max": "*",
"base": {
"path": "Observation.specimen",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Specimen"
}
]
},
{
"id": "Observation.performer",
"path": "Observation.performer",
"min": 0,
"max": "*",
"base": {
"path": "Observation.performer",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Performer2"
}
]
},
{
"id": "Observation.author",
"path": "Observation.author",
"comment": "SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-31144).",
"min": 0,
"max": "*",
"base": {
"path": "Observation.author",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Author",
"profile": [
"http://hl7.org/cda/us/ccda/StructureDefinition/AuthorParticipation"
]
}
]
},
{
"id": "Observation.informant",
"path": "Observation.informant",
"min": 0,
"max": "*",
"base": {
"path": "Observation.informant",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Informant"
}
]
},
{
"id": "Observation.participant",
"path": "Observation.participant",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "typeCode"
}
],
"rules": "open"
},
"comment": "SHOULD contain zero or more [0..*] participant (CONF:1098-16318) such that it",
"min": 0,
"max": "*",
"base": {
"path": "Observation.participant",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Participant2"
}
]
},
{
"id": "Observation.participant:consumable",
"path": "Observation.participant",
"sliceName": "consumable",
"short": "participant",
"min": 0,
"max": "*",
"base": {
"path": "Observation.participant",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Participant2"
}
]
},
{
"id": "Observation.participant:consumable.nullFlavor",
"path": "Observation.participant.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.participant:consumable.realmCode",
"path": "Observation.participant.realmCode",
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.realmCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "Observation.participant:consumable.typeId",
"path": "Observation.participant.typeId",
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min": 0,
"max": "1",
"base": {
"path": "InfrastructureRoot.typeId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint": [
{
"key": "II-1",
"severity": "error",
"human": "An II instance must have either a root or an nullFlavor.",
"expression": "root.exists() or nullFlavor.exists()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id": "Observation.participant:consumable.typeId.nullFlavor",
"path": "Observation.participant.typeId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.participant:consumable.typeId.assigningAuthorityName",
"path": "Observation.participant.typeId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.participant:consumable.typeId.displayable",
"path": "Observation.participant.typeId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "Observation.participant:consumable.typeId.root",
"path": "Observation.participant.typeId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "Identifies the type as an HL7 Registered model",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString": "2.16.840.1.113883.1.3"
},
{
"id": "Observation.participant:consumable.typeId.extension",
"path": "Observation.participant.typeId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.participant:consumable.templateId",
"path": "Observation.participant.templateId",
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "Observation.participant:consumable.typeCode",
"path": "Observation.participant.typeCode",
"representation": [
"xmlAttr"
],
"comment": "SHALL contain exactly one [1..1] @typeCode=\"CSM\" Consumable (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1098-16319).",
"min": 1,
"max": "1",
"base": {
"path": "Participant2.typeCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "CSM",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType"
}
},
{
"id": "Observation.participant:consumable.contextControlCode",
"path": "Observation.participant.contextControlCode",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "Participant2.contextControlCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "OP",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl"
}
},
{
"id": "Observation.participant:consumable.sdtcFunctionCode",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "functionCode"
}
],
"path": "Observation.participant.sdtcFunctionCode",
"min": 0,
"max": "1",
"base": {
"path": "Participant2.sdtcFunctionCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id": "Observation.participant:consumable.time",
"path": "Observation.participant.time",
"min": 0,
"max": "1",
"base": {
"path": "Participant2.time",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
}
]
},
{
"id": "Observation.participant:consumable.awarenessCode",
"path": "Observation.participant.awarenessCode",
"min": 0,
"max": "1",
"base": {
"path": "Participant2.awarenessCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id": "Observation.participant:consumable.participantRole",
"path": "Observation.participant.participantRole",
"comment": "SHALL contain exactly one [1..1] participantRole (CONF:1098-16320).",
"min": 1,
"max": "1",
"base": {
"path": "Participant2.participantRole",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole"
}
]
},
{
"id": "Observation.participant:consumable.participantRole.nullFlavor",
"path": "Observation.participant.participantRole.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.participant:consumable.participantRole.realmCode",
"path": "Observation.participant.participantRole.realmCode",
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.realmCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "Observation.participant:consumable.participantRole.typeId",
"path": "Observation.participant.participantRole.typeId",
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min": 0,
"max": "1",
"base": {
"path": "InfrastructureRoot.typeId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint": [
{
"key": "II-1",
"severity": "error",
"human": "An II instance must have either a root or an nullFlavor.",
"expression": "root.exists() or nullFlavor.exists()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id": "Observation.participant:consumable.participantRole.typeId.nullFlavor",
"path": "Observation.participant.participantRole.typeId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.participant:consumable.participantRole.typeId.assigningAuthorityName",
"path": "Observation.participant.participantRole.typeId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.participant:consumable.participantRole.typeId.displayable",
"path": "Observation.participant.participantRole.typeId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "Observation.participant:consumable.participantRole.typeId.root",
"path": "Observation.participant.participantRole.typeId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "Identifies the type as an HL7 Registered model",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString": "2.16.840.1.113883.1.3"
},
{
"id": "Observation.participant:consumable.participantRole.typeId.extension",
"path": "Observation.participant.participantRole.typeId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.participant:consumable.participantRole.templateId",
"path": "Observation.participant.participantRole.templateId",
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "Observation.participant:consumable.participantRole.classCode",
"path": "Observation.participant.participantRole.classCode",
"representation": [
"xmlAttr"
],
"comment": "This participantRole SHALL contain exactly one [1..1] @classCode=\"MANU\" Manufactured Product (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1098-16321).",
"min": 1,
"max": "1",
"base": {
"path": "ParticipantRole.classCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode": "ROL",
"fixedCode": "MANU",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot"
}
},
{
"id": "Observation.participant:consumable.participantRole.id",
"path": "Observation.participant.participantRole.id",
"min": 0,
"max": "*",
"base": {
"path": "ParticipantRole.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "Observation.participant:consumable.participantRole.sdtcIdentifiedBy",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "identifiedBy"
}
],
"path": "Observation.participant.participantRole.sdtcIdentifiedBy",
"min": 0,
"max": "*",
"base": {
"path": "ParticipantRole.sdtcIdentifiedBy",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy"
}
]
},
{
"id": "Observation.participant:consumable.participantRole.code",
"path": "Observation.participant.participantRole.code",
"min": 0,
"max": "1",
"base": {
"path": "ParticipantRole.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDARoleCode"
}
},
{
"id": "Observation.participant:consumable.participantRole.addr",
"path": "Observation.participant.participantRole.addr",
"min": 0,
"max": "*",
"base": {
"path": "ParticipantRole.addr",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/AD"
}
]
},
{
"id": "Observation.participant:consumable.participantRole.telecom",
"path": "Observation.participant.participantRole.telecom",
"min": 0,
"max": "*",
"base": {
"path": "ParticipantRole.telecom",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
]
},
{
"id": "Observation.participant:consumable.participantRole.playingDevice",
"path": "Observation.participant.participantRole.playingDevice",
"min": 0,
"max": "1",
"base": {
"path": "ParticipantRole.playingDevice",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Device"
}
]
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity",
"path": "Observation.participant.participantRole.playingEntity",
"comment": "This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1098-16322).",
"min": 1,
"max": "1",
"base": {
"path": "ParticipantRole.playingEntity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity"
}
]
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.nullFlavor",
"path": "Observation.participant.participantRole.playingEntity.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.realmCode",
"path": "Observation.participant.participantRole.playingEntity.realmCode",
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.realmCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.typeId",
"path": "Observation.participant.participantRole.playingEntity.typeId",
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min": 0,
"max": "1",
"base": {
"path": "InfrastructureRoot.typeId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint": [
{
"key": "II-1",
"severity": "error",
"human": "An II instance must have either a root or an nullFlavor.",
"expression": "root.exists() or nullFlavor.exists()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.typeId.nullFlavor",
"path": "Observation.participant.participantRole.playingEntity.typeId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.typeId.assigningAuthorityName",
"path": "Observation.participant.participantRole.playingEntity.typeId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.typeId.displayable",
"path": "Observation.participant.participantRole.playingEntity.typeId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.typeId.root",
"path": "Observation.participant.participantRole.playingEntity.typeId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "Identifies the type as an HL7 Registered model",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString": "2.16.840.1.113883.1.3"
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.typeId.extension",
"path": "Observation.participant.participantRole.playingEntity.typeId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.templateId",
"path": "Observation.participant.participantRole.playingEntity.templateId",
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.classCode",
"path": "Observation.participant.participantRole.playingEntity.classCode",
"representation": [
"xmlAttr"
],
"comment": "This playingEntity SHALL contain exactly one [1..1] @classCode=\"MMAT\" Manufactured Material (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41 STATIC) (CONF:1098-16323).",
"min": 1,
"max": "1",
"base": {
"path": "PlayingEntity.classCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode": "ENT",
"fixedCode": "MMAT",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassRoot"
}
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.determinerCode",
"path": "Observation.participant.participantRole.playingEntity.determinerCode",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "PlayingEntity.determinerCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "INSTANCE",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.code",
"path": "Observation.participant.participantRole.playingEntity.code",
"comment": "This playingEntity SHALL contain exactly one [1..1] code, which MAY be selected from ValueSet Substance Reactant for Intolerance urn:oid:2.16.840.1.113762.1.4.1010.1 DYNAMIC (CONF:1098-16324).",
"min": 1,
"max": "1",
"base": {
"path": "PlayingEntity.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.1"
}
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.quantity",
"path": "Observation.participant.participantRole.playingEntity.quantity",
"min": 0,
"max": "*",
"base": {
"path": "PlayingEntity.quantity",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PQ"
}
]
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.name",
"path": "Observation.participant.participantRole.playingEntity.name",
"min": 0,
"max": "*",
"base": {
"path": "PlayingEntity.name",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/PN"
}
]
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.sdtcBirthTime",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "birthTime"
}
],
"path": "Observation.participant.participantRole.playingEntity.sdtcBirthTime",
"definition": "The purpose of this extension is to allow the recording of the subscriber or member of a health plan in cases where the health plan eligibility system has different information on file than the provider does for the patient.",
"min": 0,
"max": "1",
"base": {
"path": "PlayingEntity.sdtcBirthTime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TS"
}
]
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.desc",
"path": "Observation.participant.participantRole.playingEntity.desc",
"min": 0,
"max": "1",
"base": {
"path": "PlayingEntity.desc",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id": "Observation.participant:consumable.participantRole.scopingEntity",
"path": "Observation.participant.participantRole.scopingEntity",
"min": 0,
"max": "1",
"base": {
"path": "ParticipantRole.scopingEntity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Entity"
}
]
},
{
"id": "Observation.entryRelationship",
"path": "Observation.entryRelationship",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "observation"
}
],
"rules": "open"
},
"comment": "SHOULD contain zero or one [0..1] entryRelationship (CONF:1098-32935) such that it",
"min": 0,
"max": "*",
"base": {
"path": "Observation.entryRelationship",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship"
}
]
},
{
"id": "Observation.entryRelationship:status",
"path": "Observation.entryRelationship",
"sliceName": "status",
"short": "entryRelationship",
"comment": "MAY contain zero or one [0..1] entryRelationship (CONF:1098-16333) such that it",
"min": 0,
"max": "1",
"base": {
"path": "Observation.entryRelationship",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship"
}
]
},
{
"id": "Observation.entryRelationship:status.nullFlavor",
"path": "Observation.entryRelationship.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.entryRelationship:status.realmCode",
"path": "Observation.entryRelationship.realmCode",
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.realmCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "Observation.entryRelationship:status.typeId",
"path": "Observation.entryRelationship.typeId",
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min": 0,
"max": "1",
"base": {
"path": "InfrastructureRoot.typeId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint": [
{
"key": "II-1",
"severity": "error",
"human": "An II instance must have either a root or an nullFlavor.",
"expression": "root.exists() or nullFlavor.exists()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id": "Observation.entryRelationship:status.typeId.nullFlavor",
"path": "Observation.entryRelationship.typeId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.entryRelationship:status.typeId.assigningAuthorityName",
"path": "Observation.entryRelationship.typeId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.entryRelationship:status.typeId.displayable",
"path": "Observation.entryRelationship.typeId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "Observation.entryRelationship:status.typeId.root",
"path": "Observation.entryRelationship.typeId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "Identifies the type as an HL7 Registered model",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString": "2.16.840.1.113883.1.3"
},
{
"id": "Observation.entryRelationship:status.typeId.extension",
"path": "Observation.entryRelationship.typeId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.entryRelationship:status.templateId",
"path": "Observation.entryRelationship.templateId",
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "Observation.entryRelationship:status.typeCode",
"path": "Observation.entryRelationship.typeCode",
"representation": [
"xmlAttr"
],
"comment": "SHALL contain exactly one [1..1] @typeCode=\"SUBJ\" Has subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16335).",
"min": 1,
"max": "1",
"base": {
"path": "EntryRelationship.typeCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "SUBJ",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship"
}
},
{
"id": "Observation.entryRelationship:status.inversionInd",
"path": "Observation.entryRelationship.inversionInd",
"representation": [
"xmlAttr"
],
"definition": "The entryRelationship.inversionInd can be set to \"true\" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.",
"comment": "SHALL contain exactly one [1..1] @inversionInd=\"true\" True (CONF:1098-16334).",
"min": 1,
"max": "1",
"base": {
"path": "EntryRelationship.inversionInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
],
"fixedBoolean": true
},
{
"id": "Observation.entryRelationship:status.contextConductionInd",
"path": "Observation.entryRelationship.contextConductionInd",
"representation": [
"xmlAttr"
],
"definition": "The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at \"true\", whereas here the value is defaulted to \"true\", and can be changed to \"false\" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.contextConductionInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
],
"defaultValueBoolean": true
},
{
"id": "Observation.entryRelationship:status.negationInd",
"path": "Observation.entryRelationship.negationInd",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.negationInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "Observation.entryRelationship:status.sequenceNumber",
"path": "Observation.entryRelationship.sequenceNumber",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.sequenceNumber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/INT"
}
]
},
{
"id": "Observation.entryRelationship:status.seperatableInd",
"path": "Observation.entryRelationship.seperatableInd",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.seperatableInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/BL"
}
]
},
{
"id": "Observation.entryRelationship:status.act",
"path": "Observation.entryRelationship.act",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.act",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Act"
}
]
},
{
"id": "Observation.entryRelationship:status.encounter",
"path": "Observation.entryRelationship.encounter",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.encounter",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Encounter"
}
]
},
{
"id": "Observation.entryRelationship:status.observation",
"path": "Observation.entryRelationship.observation",
"comment": "SHALL contain exactly one [1..1] Allergy Status Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.28:2019-06-20) (CONF:1098-16336).",
"min": 1,
"max": "1",
"base": {
"path": "EntryRelationship.observation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Observation",
"profile": [
"http://hl7.org/cda/us/ccda/StructureDefinition/AllergyStatusObservation"
]
}
]
},
{
"id": "Observation.entryRelationship:status.observationMedia",
"path": "Observation.entryRelationship.observationMedia",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.observationMedia",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia"
}
]
},
{
"id": "Observation.entryRelationship:status.organizer",
"path": "Observation.entryRelationship.organizer",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.organizer",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Organizer"
}
]
},
{
"id": "Observation.entryRelationship:status.procedure",
"path": "Observation.entryRelationship.procedure",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.procedure",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Procedure"
}
]
},
{
"id": "Observation.entryRelationship:status.regionOfInterest",
"path": "Observation.entryRelationship.regionOfInterest",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.regionOfInterest",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest"
}
]
},
{
"id": "Observation.entryRelationship:status.substanceAdministration",
"path": "Observation.entryRelationship.substanceAdministration",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.substanceAdministration",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration"
}
]
},
{
"id": "Observation.entryRelationship:status.supply",
"path": "Observation.entryRelationship.supply",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.supply",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Supply"
}
]
},
{
"id": "Observation.entryRelationship:reaction",
"path": "Observation.entryRelationship",
"sliceName": "reaction",
"short": "entryRelationship",
"comment": "SHOULD contain zero or more [0..*] entryRelationship (CONF:1098-16337) such that it",
"min": 0,
"max": "*",
"base": {
"path": "Observation.entryRelationship",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship"
}
]
},
{
"id": "Observation.entryRelationship:reaction.nullFlavor",
"path": "Observation.entryRelationship.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.entryRelationship:reaction.realmCode",
"path": "Observation.entryRelationship.realmCode",
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.realmCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "Observation.entryRelationship:reaction.typeId",
"path": "Observation.entryRelationship.typeId",
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min": 0,
"max": "1",
"base": {
"path": "InfrastructureRoot.typeId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint": [
{
"key": "II-1",
"severity": "error",
"human": "An II instance must have either a root or an nullFlavor.",
"expression": "root.exists() or nullFlavor.exists()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id": "Observation.entryRelationship:reaction.typeId.nullFlavor",
"path": "Observation.entryRelationship.typeId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.entryRelationship:reaction.typeId.assigningAuthorityName",
"path": "Observation.entryRelationship.typeId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.entryRelationship:reaction.typeId.displayable",
"path": "Observation.entryRelationship.typeId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "Observation.entryRelationship:reaction.typeId.root",
"path": "Observation.entryRelationship.typeId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "Identifies the type as an HL7 Registered model",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString": "2.16.840.1.113883.1.3"
},
{
"id": "Observation.entryRelationship:reaction.typeId.extension",
"path": "Observation.entryRelationship.typeId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.entryRelationship:reaction.templateId",
"path": "Observation.entryRelationship.templateId",
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "Observation.entryRelationship:reaction.typeCode",
"path": "Observation.entryRelationship.typeCode",
"representation": [
"xmlAttr"
],
"comment": "SHALL contain exactly one [1..1] @typeCode=\"MFST\" Is Manifestation of (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16339).",
"min": 1,
"max": "1",
"base": {
"path": "EntryRelationship.typeCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "MFST",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship"
}
},
{
"id": "Observation.entryRelationship:reaction.inversionInd",
"path": "Observation.entryRelationship.inversionInd",
"representation": [
"xmlAttr"
],
"definition": "The entryRelationship.inversionInd can be set to \"true\" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.",
"comment": "SHALL contain exactly one [1..1] @inversionInd=\"true\" True (CONF:1098-16338).",
"min": 1,
"max": "1",
"base": {
"path": "EntryRelationship.inversionInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
],
"fixedBoolean": true
},
{
"id": "Observation.entryRelationship:reaction.contextConductionInd",
"path": "Observation.entryRelationship.contextConductionInd",
"representation": [
"xmlAttr"
],
"definition": "The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at \"true\", whereas here the value is defaulted to \"true\", and can be changed to \"false\" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.contextConductionInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
],
"defaultValueBoolean": true
},
{
"id": "Observation.entryRelationship:reaction.negationInd",
"path": "Observation.entryRelationship.negationInd",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.negationInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "Observation.entryRelationship:reaction.sequenceNumber",
"path": "Observation.entryRelationship.sequenceNumber",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.sequenceNumber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/INT"
}
]
},
{
"id": "Observation.entryRelationship:reaction.seperatableInd",
"path": "Observation.entryRelationship.seperatableInd",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.seperatableInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/BL"
}
]
},
{
"id": "Observation.entryRelationship:reaction.act",
"path": "Observation.entryRelationship.act",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.act",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Act"
}
]
},
{
"id": "Observation.entryRelationship:reaction.encounter",
"path": "Observation.entryRelationship.encounter",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.encounter",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Encounter"
}
]
},
{
"id": "Observation.entryRelationship:reaction.observation",
"path": "Observation.entryRelationship.observation",
"comment": "SHALL contain exactly one [1..1] Reaction Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.9:2014-06-09) (CONF:1098-16340).",
"min": 1,
"max": "1",
"base": {
"path": "EntryRelationship.observation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Observation",
"profile": [
"http://hl7.org/cda/us/ccda/StructureDefinition/ReactionObservation"
]
}
]
},
{
"id": "Observation.entryRelationship:reaction.observationMedia",
"path": "Observation.entryRelationship.observationMedia",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.observationMedia",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia"
}
]
},
{
"id": "Observation.entryRelationship:reaction.organizer",
"path": "Observation.entryRelationship.organizer",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.organizer",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Organizer"
}
]
},
{
"id": "Observation.entryRelationship:reaction.procedure",
"path": "Observation.entryRelationship.procedure",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.procedure",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Procedure"
}
]
},
{
"id": "Observation.entryRelationship:reaction.regionOfInterest",
"path": "Observation.entryRelationship.regionOfInterest",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.regionOfInterest",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest"
}
]
},
{
"id": "Observation.entryRelationship:reaction.substanceAdministration",
"path": "Observation.entryRelationship.substanceAdministration",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.substanceAdministration",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration"
}
]
},
{
"id": "Observation.entryRelationship:reaction.supply",
"path": "Observation.entryRelationship.supply",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.supply",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Supply"
}
]
},
{
"id": "Observation.entryRelationship:severity",
"path": "Observation.entryRelationship",
"sliceName": "severity",
"short": "entryRelationship",
"comment": "SHOULD NOT contain zero or one [0..1] entryRelationship (CONF:1098-16341) such that it",
"min": 0,
"max": "1",
"base": {
"path": "Observation.entryRelationship",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship"
}
]
},
{
"id": "Observation.entryRelationship:severity.nullFlavor",
"path": "Observation.entryRelationship.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.entryRelationship:severity.realmCode",
"path": "Observation.entryRelationship.realmCode",
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.realmCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "Observation.entryRelationship:severity.typeId",
"path": "Observation.entryRelationship.typeId",
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min": 0,
"max": "1",
"base": {
"path": "InfrastructureRoot.typeId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint": [
{
"key": "II-1",
"severity": "error",
"human": "An II instance must have either a root or an nullFlavor.",
"expression": "root.exists() or nullFlavor.exists()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id": "Observation.entryRelationship:severity.typeId.nullFlavor",
"path": "Observation.entryRelationship.typeId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.entryRelationship:severity.typeId.assigningAuthorityName",
"path": "Observation.entryRelationship.typeId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.entryRelationship:severity.typeId.displayable",
"path": "Observation.entryRelationship.typeId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "Observation.entryRelationship:severity.typeId.root",
"path": "Observation.entryRelationship.typeId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "Identifies the type as an HL7 Registered model",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString": "2.16.840.1.113883.1.3"
},
{
"id": "Observation.entryRelationship:severity.typeId.extension",
"path": "Observation.entryRelationship.typeId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.entryRelationship:severity.templateId",
"path": "Observation.entryRelationship.templateId",
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "Observation.entryRelationship:severity.typeCode",
"path": "Observation.entryRelationship.typeCode",
"representation": [
"xmlAttr"
],
"comment": "SHALL contain exactly one [1..1] @typeCode=\"SUBJ\" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16342).",
"min": 1,
"max": "1",
"base": {
"path": "EntryRelationship.typeCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "SUBJ",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship"
}
},
{
"id": "Observation.entryRelationship:severity.inversionInd",
"path": "Observation.entryRelationship.inversionInd",
"representation": [
"xmlAttr"
],
"definition": "The entryRelationship.inversionInd can be set to \"true\" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.",
"comment": "SHALL contain exactly one [1..1] @inversionInd=\"true\" True (CONF:1098-16343).",
"min": 1,
"max": "1",
"base": {
"path": "EntryRelationship.inversionInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
],
"fixedBoolean": true
},
{
"id": "Observation.entryRelationship:severity.contextConductionInd",
"path": "Observation.entryRelationship.contextConductionInd",
"representation": [
"xmlAttr"
],
"definition": "The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at \"true\", whereas here the value is defaulted to \"true\", and can be changed to \"false\" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.contextConductionInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
],
"defaultValueBoolean": true
},
{
"id": "Observation.entryRelationship:severity.negationInd",
"path": "Observation.entryRelationship.negationInd",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.negationInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "Observation.entryRelationship:severity.sequenceNumber",
"path": "Observation.entryRelationship.sequenceNumber",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.sequenceNumber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/INT"
}
]
},
{
"id": "Observation.entryRelationship:severity.seperatableInd",
"path": "Observation.entryRelationship.seperatableInd",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.seperatableInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/BL"
}
]
},
{
"id": "Observation.entryRelationship:severity.act",
"path": "Observation.entryRelationship.act",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.act",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Act"
}
]
},
{
"id": "Observation.entryRelationship:severity.encounter",
"path": "Observation.entryRelationship.encounter",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.encounter",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Encounter"
}
]
},
{
"id": "Observation.entryRelationship:severity.observation",
"path": "Observation.entryRelationship.observation",
"comment": "SHALL contain exactly one [1..1] Severity Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.8:2014-06-09) (CONF:1098-16344).",
"min": 1,
"max": "1",
"base": {
"path": "EntryRelationship.observation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Observation",
"profile": [
"http://hl7.org/cda/us/ccda/StructureDefinition/SeverityObservation"
]
}
]
},
{
"id": "Observation.entryRelationship:severity.observationMedia",
"path": "Observation.entryRelationship.observationMedia",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.observationMedia",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia"
}
]
},
{
"id": "Observation.entryRelationship:severity.organizer",
"path": "Observation.entryRelationship.organizer",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.organizer",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Organizer"
}
]
},
{
"id": "Observation.entryRelationship:severity.procedure",
"path": "Observation.entryRelationship.procedure",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.procedure",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Procedure"
}
]
},
{
"id": "Observation.entryRelationship:severity.regionOfInterest",
"path": "Observation.entryRelationship.regionOfInterest",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.regionOfInterest",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest"
}
]
},
{
"id": "Observation.entryRelationship:severity.substanceAdministration",
"path": "Observation.entryRelationship.substanceAdministration",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.substanceAdministration",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration"
}
]
},
{
"id": "Observation.entryRelationship:severity.supply",
"path": "Observation.entryRelationship.supply",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.supply",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Supply"
}
]
},
{
"id": "Observation.entryRelationship:criticality",
"path": "Observation.entryRelationship",
"sliceName": "criticality",
"short": "entryRelationship",
"min": 0,
"max": "1",
"base": {
"path": "Observation.entryRelationship",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship"
}
]
},
{
"id": "Observation.entryRelationship:criticality.nullFlavor",
"path": "Observation.entryRelationship.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.entryRelationship:criticality.realmCode",
"path": "Observation.entryRelationship.realmCode",
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.realmCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "Observation.entryRelationship:criticality.typeId",
"path": "Observation.entryRelationship.typeId",
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min": 0,
"max": "1",
"base": {
"path": "InfrastructureRoot.typeId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint": [
{
"key": "II-1",
"severity": "error",
"human": "An II instance must have either a root or an nullFlavor.",
"expression": "root.exists() or nullFlavor.exists()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id": "Observation.entryRelationship:criticality.typeId.nullFlavor",
"path": "Observation.entryRelationship.typeId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.entryRelationship:criticality.typeId.assigningAuthorityName",
"path": "Observation.entryRelationship.typeId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.entryRelationship:criticality.typeId.displayable",
"path": "Observation.entryRelationship.typeId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "Observation.entryRelationship:criticality.typeId.root",
"path": "Observation.entryRelationship.typeId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "Identifies the type as an HL7 Registered model",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString": "2.16.840.1.113883.1.3"
},
{
"id": "Observation.entryRelationship:criticality.typeId.extension",
"path": "Observation.entryRelationship.typeId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.entryRelationship:criticality.templateId",
"path": "Observation.entryRelationship.templateId",
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "Observation.entryRelationship:criticality.typeCode",
"path": "Observation.entryRelationship.typeCode",
"representation": [
"xmlAttr"
],
"comment": "SHALL contain exactly one [1..1] @typeCode=\"SUBJ\" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32936).",
"min": 1,
"max": "1",
"base": {
"path": "EntryRelationship.typeCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "SUBJ",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship"
}
},
{
"id": "Observation.entryRelationship:criticality.inversionInd",
"path": "Observation.entryRelationship.inversionInd",
"representation": [
"xmlAttr"
],
"definition": "The entryRelationship.inversionInd can be set to \"true\" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.",
"comment": "SHALL contain exactly one [1..1] @inversionInd=\"true\" True (CONF:1098-32937).",
"min": 1,
"max": "1",
"base": {
"path": "EntryRelationship.inversionInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
],
"fixedBoolean": true
},
{
"id": "Observation.entryRelationship:criticality.contextConductionInd",
"path": "Observation.entryRelationship.contextConductionInd",
"representation": [
"xmlAttr"
],
"definition": "The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at \"true\", whereas here the value is defaulted to \"true\", and can be changed to \"false\" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.contextConductionInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
],
"defaultValueBoolean": true
},
{
"id": "Observation.entryRelationship:criticality.negationInd",
"path": "Observation.entryRelationship.negationInd",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.negationInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "Observation.entryRelationship:criticality.sequenceNumber",
"path": "Observation.entryRelationship.sequenceNumber",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.sequenceNumber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/INT"
}
]
},
{
"id": "Observation.entryRelationship:criticality.seperatableInd",
"path": "Observation.entryRelationship.seperatableInd",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.seperatableInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/BL"
}
]
},
{
"id": "Observation.entryRelationship:criticality.act",
"path": "Observation.entryRelationship.act",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.act",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Act"
}
]
},
{
"id": "Observation.entryRelationship:criticality.encounter",
"path": "Observation.entryRelationship.encounter",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.encounter",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Encounter"
}
]
},
{
"id": "Observation.entryRelationship:criticality.observation",
"path": "Observation.entryRelationship.observation",
"comment": "SHALL contain exactly one [1..1] Criticality Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.145) (CONF:1098-32938).",
"min": 1,
"max": "1",
"base": {
"path": "EntryRelationship.observation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Observation",
"profile": [
"http://hl7.org/cda/us/ccda/StructureDefinition/CriticalityObservation"
]
}
]
},
{
"id": "Observation.entryRelationship:criticality.observationMedia",
"path": "Observation.entryRelationship.observationMedia",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.observationMedia",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia"
}
]
},
{
"id": "Observation.entryRelationship:criticality.organizer",
"path": "Observation.entryRelationship.organizer",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.organizer",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Organizer"
}
]
},
{
"id": "Observation.entryRelationship:criticality.procedure",
"path": "Observation.entryRelationship.procedure",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.procedure",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Procedure"
}
]
},
{
"id": "Observation.entryRelationship:criticality.regionOfInterest",
"path": "Observation.entryRelationship.regionOfInterest",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.regionOfInterest",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest"
}
]
},
{
"id": "Observation.entryRelationship:criticality.substanceAdministration",
"path": "Observation.entryRelationship.substanceAdministration",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.substanceAdministration",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration"
}
]
},
{
"id": "Observation.entryRelationship:criticality.supply",
"path": "Observation.entryRelationship.supply",
"min": 0,
"max": "1",
"base": {
"path": "EntryRelationship.supply",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Supply"
}
]
},
{
"id": "Observation.reference",
"path": "Observation.reference",
"min": 0,
"max": "*",
"base": {
"path": "Observation.reference",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Reference"
}
]
},
{
"id": "Observation.precondition",
"path": "Observation.precondition",
"min": 0,
"max": "*",
"base": {
"path": "Observation.precondition",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Precondition"
}
]
},
{
"id": "Observation.sdtcPrecondition2",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "precondition2"
}
],
"path": "Observation.sdtcPrecondition2",
"min": 0,
"max": "*",
"base": {
"path": "Observation.sdtcPrecondition2",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Precondition2"
}
]
},
{
"id": "Observation.referenceRange",
"path": "Observation.referenceRange",
"definition": "Relates an Observation to the ObservationRange class, where the expected range of values for a particular observation can be specified.",
"min": 0,
"max": "*",
"base": {
"path": "Observation.referenceRange",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id": "Observation.referenceRange.nullFlavor",
"path": "Observation.referenceRange.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.referenceRange.realmCode",
"path": "Observation.referenceRange.realmCode",
"definition": "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.realmCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "Observation.referenceRange.typeId",
"path": "Observation.referenceRange.typeId",
"definition": "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min": 0,
"max": "1",
"base": {
"path": "InfrastructureRoot.typeId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint": [
{
"key": "II-1",
"severity": "error",
"human": "An II instance must have either a root or an nullFlavor.",
"expression": "root.exists() or nullFlavor.exists()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/Observation"
}
]
},
{
"id": "Observation.referenceRange.typeId.nullFlavor",
"path": "Observation.referenceRange.typeId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "Observation.referenceRange.typeId.assigningAuthorityName",
"path": "Observation.referenceRange.typeId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.referenceRange.typeId.displayable",
"path": "Observation.referenceRange.typeId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "Observation.referenceRange.typeId.root",
"path": "Observation.referenceRange.typeId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "Identifies the type as an HL7 Registered model",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString": "2.16.840.1.113883.1.3"
},
{
"id": "Observation.referenceRange.typeId.extension",
"path": "Observation.referenceRange.typeId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "Observation.referenceRange.templateId",
"path": "Observation.referenceRange.templateId",
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "Observation.referenceRange.typeCode",
"path": "Observation.referenceRange.typeCode",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "Observation.referenceRange.typeCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "REFV",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType"
}
},
{
"id": "Observation.referenceRange.observationRange",
"path": "Observation.referenceRange.observationRange",
"min": 1,
"max": "1",
"base": {
"path": "Observation.referenceRange.observationRange",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ObservationRange"
}
]
},
{
"id": "Observation.sdtcInFulfillmentOf1",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "inFulfillmentOf1"
}
],
"path": "Observation.sdtcInFulfillmentOf1",
"min": 0,
"max": "*",
"base": {
"path": "Observation.sdtcInFulfillmentOf1",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Observation",
"path": "Observation",
"constraint": [
{
"key": "should-text-ref-value",
"severity": "warning",
"human": "SHOULD contain text/reference/@value",
"expression": "text.reference.value.exists()",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/SubstanceOrDeviceAllergyIntoleranceObservation"
},
{
"key": "should-author",
"severity": "warning",
"human": "SHOULD contain author",
"expression": "author.exists()",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/SubstanceOrDeviceAllergyIntoleranceObservation"
},
{
"key": "should-not-severity",
"severity": "warning",
"human": "Allergy SHOULD NOT include severity. Severity belongs at reaction level, while Criticality is used at the allergy level.",
"expression": "entryRelationship.observation.where(code.code = 'SEV' and code.codeSystem = '2.16.840.1.113883.5.4').empty()",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/SubstanceOrDeviceAllergyIntoleranceObservation"
}
]
},
{
"id": "Observation.templateId",
"path": "Observation.templateId",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "root"
},
{
"type": "value",
"path": "extension"
}
],
"rules": "open"
},
"min": 1
},
{
"id": "Observation.templateId:substance-device-allergy-intolerance-obs",
"path": "Observation.templateId",
"sliceName": "substance-device-allergy-intolerance-obs",
"min": 1,
"max": "1"
},
{
"id": "Observation.templateId:substance-device-allergy-intolerance-obs.root",
"path": "Observation.templateId.root",
"min": 1,
"patternString": "2.16.840.1.113883.10.20.24.3.90"
},
{
"id": "Observation.templateId:substance-device-allergy-intolerance-obs.extension",
"path": "Observation.templateId.extension",
"min": 1,
"patternString": "2014-06-09"
},
{
"id": "Observation.classCode",
"path": "Observation.classCode",
"comment": "SHALL contain exactly one [1..1] @classCode=\"OBS\" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-16303).",
"fixedCode": "OBS"
},
{
"id": "Observation.moodCode",
"path": "Observation.moodCode",
"comment": "SHALL contain exactly one [1..1] @moodCode=\"EVN\" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-16304).",
"fixedCode": "EVN"
},
{
"id": "Observation.id",
"path": "Observation.id",
"comment": "SHALL contain at least one [1..*] id (CONF:1098-16307).",
"min": 1
},
{
"id": "Observation.code",
"path": "Observation.code",
"comment": "SHALL contain exactly one [1..1] code (CONF:1098-16345)."
},
{
"id": "Observation.code.code",
"path": "Observation.code.code",
"comment": "This code SHALL contain exactly one [1..1] @code=\"ASSERTION\" Assertion (CONF:1098-16346).",
"min": 1,
"patternCode": "ASSERTION"
},
{
"id": "Observation.code.codeSystem",
"path": "Observation.code.codeSystem",
"comment": "This code SHALL contain exactly one [1..1] @codeSystem=\"2.16.840.1.113883.5.4\" (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:1098-32171).",
"min": 1,
"patternString": "2.16.840.1.113883.5.4"
},
{
"id": "Observation.text",
"path": "Observation.text",
"short": "SHOULD reference the portion of section narrative text corresponding to this entry"
},
{
"id": "Observation.text.reference",
"path": "Observation.text.reference",
"constraint": [
{
"key": "value-starts-octothorpe",
"severity": "error",
"human": "If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative",
"expression": "value.exists() implies value.startsWith('#')",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/SubstanceOrDeviceAllergyIntoleranceObservation"
}
]
},
{
"id": "Observation.statusCode",
"path": "Observation.statusCode",
"comment": "SHALL contain exactly one [1..1] statusCode (CONF:1098-16308).",
"min": 1
},
{
"id": "Observation.statusCode.code",
"path": "Observation.statusCode.code",
"comment": "This statusCode SHALL contain exactly one [1..1] @code=\"completed\" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-26354).",
"min": 1,
"fixedCode": "completed"
},
{
"id": "Observation.effectiveTime",
"path": "Observation.effectiveTime",
"short": "The effectiveTime/low (a.k.a. \"onset date\") asserts when the allergy/intolerance became clinically active. The effectiveTime/high (a.k.a. \"resolution date\") asserts when the allergy/intolerance became clinically resolved. If the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'.",
"comment": "SHALL contain exactly one [1..1] effectiveTime (CONF:1098-16309).",
"min": 1
},
{
"id": "Observation.effectiveTime.low",
"path": "Observation.effectiveTime.low",
"comment": "This effectiveTime SHALL contain exactly one [1..1] low (CONF:1098-31536).",
"min": 1
},
{
"id": "Observation.effectiveTime.high",
"path": "Observation.effectiveTime.high",
"comment": "This effectiveTime MAY contain zero or one [0..1] high (CONF:1098-31537)."
},
{
"id": "Observation.value",
"path": "Observation.value",
"comment": "SHALL contain exactly one [1..1] value with @xsi:type=\"CD\" (CONF:1098-16312).",
"min": 1,
"max": "1",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id": "Observation.value.nullFlavor",
"path": "Observation.value.nullFlavor",
"max": "0"
},
{
"id": "Observation.value.code",
"path": "Observation.value.code",
"min": 1,
"binding": {
"strength": "required",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.3.88.12.3221.6.2"
}
},
{
"id": "Observation.author",
"path": "Observation.author",
"comment": "SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-31144).",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Author",
"profile": [
"http://hl7.org/cda/us/ccda/StructureDefinition/AuthorParticipation"
]
}
]
},
{
"id": "Observation.participant",
"path": "Observation.participant",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "typeCode"
}
],
"rules": "open"
},
"comment": "SHOULD contain zero or more [0..*] participant (CONF:1098-16318) such that it"
},
{
"id": "Observation.participant:consumable",
"path": "Observation.participant",
"sliceName": "consumable",
"short": "participant",
"min": 0,
"max": "*"
},
{
"id": "Observation.participant:consumable.typeCode",
"path": "Observation.participant.typeCode",
"comment": "SHALL contain exactly one [1..1] @typeCode=\"CSM\" Consumable (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1098-16319).",
"fixedCode": "CSM"
},
{
"id": "Observation.participant:consumable.participantRole",
"path": "Observation.participant.participantRole",
"comment": "SHALL contain exactly one [1..1] participantRole (CONF:1098-16320)."
},
{
"id": "Observation.participant:consumable.participantRole.classCode",
"path": "Observation.participant.participantRole.classCode",
"comment": "This participantRole SHALL contain exactly one [1..1] @classCode=\"MANU\" Manufactured Product (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1098-16321).",
"min": 1,
"fixedCode": "MANU"
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity",
"path": "Observation.participant.participantRole.playingEntity",
"comment": "This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1098-16322).",
"min": 1
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.classCode",
"path": "Observation.participant.participantRole.playingEntity.classCode",
"comment": "This playingEntity SHALL contain exactly one [1..1] @classCode=\"MMAT\" Manufactured Material (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41 STATIC) (CONF:1098-16323).",
"min": 1,
"fixedCode": "MMAT"
},
{
"id": "Observation.participant:consumable.participantRole.playingEntity.code",
"path": "Observation.participant.participantRole.playingEntity.code",
"comment": "This playingEntity SHALL contain exactly one [1..1] code, which MAY be selected from ValueSet Substance Reactant for Intolerance urn:oid:2.16.840.1.113762.1.4.1010.1 DYNAMIC (CONF:1098-16324).",
"min": 1,
"binding": {
"strength": "preferred",
"valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.1"
}
},
{
"id": "Observation.entryRelationship",
"path": "Observation.entryRelationship",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "observation"
}
],
"rules": "open"
},
"comment": "SHOULD contain zero or one [0..1] entryRelationship (CONF:1098-32935) such that it"
},
{
"id": "Observation.entryRelationship:status",
"path": "Observation.entryRelationship",
"sliceName": "status",
"short": "entryRelationship",
"comment": "MAY contain zero or one [0..1] entryRelationship (CONF:1098-16333) such that it",
"min": 0,
"max": "1"
},
{
"id": "Observation.entryRelationship:status.typeCode",
"path": "Observation.entryRelationship.typeCode",
"comment": "SHALL contain exactly one [1..1] @typeCode=\"SUBJ\" Has subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16335).",
"fixedCode": "SUBJ"
},
{
"id": "Observation.entryRelationship:status.inversionInd",
"path": "Observation.entryRelationship.inversionInd",
"comment": "SHALL contain exactly one [1..1] @inversionInd=\"true\" True (CONF:1098-16334).",
"min": 1,
"fixedBoolean": true
},
{
"id": "Observation.entryRelationship:status.observation",
"path": "Observation.entryRelationship.observation",
"comment": "SHALL contain exactly one [1..1] Allergy Status Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.28:2019-06-20) (CONF:1098-16336).",
"min": 1,
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Observation",
"profile": [
"http://hl7.org/cda/us/ccda/StructureDefinition/AllergyStatusObservation"
]
}
]
},
{
"id": "Observation.entryRelationship:reaction",
"path": "Observation.entryRelationship",
"sliceName": "reaction",
"short": "entryRelationship",
"comment": "SHOULD contain zero or more [0..*] entryRelationship (CONF:1098-16337) such that it",
"min": 0,
"max": "*"
},
{
"id": "Observation.entryRelationship:reaction.typeCode",
"path": "Observation.entryRelationship.typeCode",
"comment": "SHALL contain exactly one [1..1] @typeCode=\"MFST\" Is Manifestation of (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16339).",
"fixedCode": "MFST"
},
{
"id": "Observation.entryRelationship:reaction.inversionInd",
"path": "Observation.entryRelationship.inversionInd",
"comment": "SHALL contain exactly one [1..1] @inversionInd=\"true\" True (CONF:1098-16338).",
"min": 1,
"fixedBoolean": true
},
{
"id": "Observation.entryRelationship:reaction.observation",
"path": "Observation.entryRelationship.observation",
"comment": "SHALL contain exactly one [1..1] Reaction Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.9:2014-06-09) (CONF:1098-16340).",
"min": 1,
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Observation",
"profile": [
"http://hl7.org/cda/us/ccda/StructureDefinition/ReactionObservation"
]
}
]
},
{
"id": "Observation.entryRelationship:severity",
"path": "Observation.entryRelationship",
"sliceName": "severity",
"short": "entryRelationship",
"comment": "SHOULD NOT contain zero or one [0..1] entryRelationship (CONF:1098-16341) such that it",
"min": 0,
"max": "1"
},
{
"id": "Observation.entryRelationship:severity.typeCode",
"path": "Observation.entryRelationship.typeCode",
"comment": "SHALL contain exactly one [1..1] @typeCode=\"SUBJ\" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16342).",
"fixedCode": "SUBJ"
},
{
"id": "Observation.entryRelationship:severity.inversionInd",
"path": "Observation.entryRelationship.inversionInd",
"comment": "SHALL contain exactly one [1..1] @inversionInd=\"true\" True (CONF:1098-16343).",
"min": 1,
"fixedBoolean": true
},
{
"id": "Observation.entryRelationship:severity.observation",
"path": "Observation.entryRelationship.observation",
"comment": "SHALL contain exactly one [1..1] Severity Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.8:2014-06-09) (CONF:1098-16344).",
"min": 1,
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Observation",
"profile": [
"http://hl7.org/cda/us/ccda/StructureDefinition/SeverityObservation"
]
}
]
},
{
"id": "Observation.entryRelationship:criticality",
"path": "Observation.entryRelationship",
"sliceName": "criticality",
"short": "entryRelationship",
"min": 0,
"max": "1"
},
{
"id": "Observation.entryRelationship:criticality.typeCode",
"path": "Observation.entryRelationship.typeCode",
"comment": "SHALL contain exactly one [1..1] @typeCode=\"SUBJ\" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32936).",
"fixedCode": "SUBJ"
},
{
"id": "Observation.entryRelationship:criticality.inversionInd",
"path": "Observation.entryRelationship.inversionInd",
"comment": "SHALL contain exactly one [1..1] @inversionInd=\"true\" True (CONF:1098-32937).",
"min": 1,
"fixedBoolean": true
},
{
"id": "Observation.entryRelationship:criticality.observation",
"path": "Observation.entryRelationship.observation",
"comment": "SHALL contain exactly one [1..1] Criticality Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.145) (CONF:1098-32938).",
"min": 1,
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Observation",
"profile": [
"http://hl7.org/cda/us/ccda/StructureDefinition/CriticalityObservation"
]
}
]
}
]
}
}